This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/hspc-allergyintolerance
The HSPC specific profile for an allergy or intolerance
This profile was published on Tue, Jul 28, 2015 00:00+1000 as a draft by HSPC.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from AllergyIntolerance.
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from AllergyIntolerance.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance) | |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
hspc-allergyintolerance-DateOfResolution | 0..* | date | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-allergyintolerance-DateOfResolution | |
hspc-allergyintolerance-PatientInformedInd | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-allergyintolerance-PatientInformedInd Binding: v2 Yes/no Indicator (preferred) | |
hspc-allergyintolerance-CauseOfDeathInd | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-allergyintolerance-CauseOfDeathInd Binding: v2 Yes/no Indicator (preferred) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | External ids for this item |
onset | ∑ | 0..1 | dateTime | Date(/time) when manifestations showed |
recordedDate | ∑ | 0..1 | dateTime | When recorded |
recorder | ∑ | 0..1 | Reference(HSPC ProviderPractitioner | HSPC-Patient) | Who recorded the sensitivity |
patient | ∑ | 1..1 | Reference(Patient) | Who the sensitivity is for |
reporter | ∑ | 0..1 | Reference(HSPC ProviderPractitioner | HSPC-Patient | RelatedPerson) | Source of the information about the allergy |
substance | ∑ | 1..1 | CodeableConcept | Substance, (or class) considered to be responsible for risk Binding: HSPC Substance Value Set (preferred) |
status | ?! ∑ | 0..1 | code | active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error Binding: AllergyIntoleranceStatus (required) |
criticality | ∑ | 0..1 | code | CRITL | CRITH | CRITU Binding: AllergyIntoleranceCriticality (required) |
type | ∑ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
category | ∑ | 0..1 | code | food | medication | environment | other - Category of Substance Binding: AllergyIntoleranceCategory (required) |
lastOccurence | ∑ | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction |
note | 0..1 | Annotation | Additional text not captured in other fields | |
reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
substance | ∑ | 0..1 | CodeableConcept | Specific substance considered to be responsible for event Binding: Substance Code (example) |
certainty | ∑ | 0..1 | code | unlikely | likely | confirmed - clinical certainty about the specific substance Binding: AllergyIntoleranceCertainty (required) |
manifestation | ∑ | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: HSPC SNOMED Clinical Findings Value Set Definition (preferred) |
description | 0..1 | string | Description of the event as a whole | |
onset | ∑ | 0..1 | dateTime | Date(/time) when manifestations showed |
severity | ∑ | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) |
exposureRoute | ∑ | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: v3 Code System RouteOfAdministration (preferred) |
note | 0..1 | Annotation | Text about event not captured in other fields | |
Documentation for this format |
todo
This structure is derived from AllergyIntolerance.
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from AllergyIntolerance.
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance) | |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
hspc-allergyintolerance-DateOfResolution | 0..* | date | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-allergyintolerance-DateOfResolution | |
hspc-allergyintolerance-PatientInformedInd | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-allergyintolerance-PatientInformedInd Binding: v2 Yes/no Indicator (preferred) | |
hspc-allergyintolerance-CauseOfDeathInd | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-allergyintolerance-CauseOfDeathInd Binding: v2 Yes/no Indicator (preferred) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | External ids for this item |
onset | ∑ | 0..1 | dateTime | Date(/time) when manifestations showed |
recordedDate | ∑ | 0..1 | dateTime | When recorded |
recorder | ∑ | 0..1 | Reference(HSPC ProviderPractitioner | HSPC-Patient) | Who recorded the sensitivity |
patient | ∑ | 1..1 | Reference(Patient) | Who the sensitivity is for |
reporter | ∑ | 0..1 | Reference(HSPC ProviderPractitioner | HSPC-Patient | RelatedPerson) | Source of the information about the allergy |
substance | ∑ | 1..1 | CodeableConcept | Substance, (or class) considered to be responsible for risk Binding: HSPC Substance Value Set (preferred) |
status | ?! ∑ | 0..1 | code | active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error Binding: AllergyIntoleranceStatus (required) |
criticality | ∑ | 0..1 | code | CRITL | CRITH | CRITU Binding: AllergyIntoleranceCriticality (required) |
type | ∑ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
category | ∑ | 0..1 | code | food | medication | environment | other - Category of Substance Binding: AllergyIntoleranceCategory (required) |
lastOccurence | ∑ | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction |
note | 0..1 | Annotation | Additional text not captured in other fields | |
reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
substance | ∑ | 0..1 | CodeableConcept | Specific substance considered to be responsible for event Binding: Substance Code (example) |
certainty | ∑ | 0..1 | code | unlikely | likely | confirmed - clinical certainty about the specific substance Binding: AllergyIntoleranceCertainty (required) |
manifestation | ∑ | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: HSPC SNOMED Clinical Findings Value Set Definition (preferred) |
description | 0..1 | string | Description of the event as a whole | |
onset | ∑ | 0..1 | dateTime | Date(/time) when manifestations showed |
severity | ∑ | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) |
exposureRoute | ∑ | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: v3 Code System RouteOfAdministration (preferred) |
note | 0..1 | Annotation | Text about event not captured in other fields | |
Documentation for this format |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
AllergyIntolerance.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
AllergyIntolerance.extension [UriType[http://hl7.org/fhir/StructureDefinition/hspc-allergyintolerance-PatientInformedInd]] | v2 Yes/no Indicator | preferred | v2 Yes/no Indicator |
AllergyIntolerance.extension [UriType[http://hl7.org/fhir/StructureDefinition/hspc-allergyintolerance-CauseOfDeathInd]] | v2 Yes/no Indicator | preferred | v2 Yes/no Indicator |
AllergyIntolerance.substance | HSPC Substance Value Set | preferred | HSPC Substance Value Set |
AllergyIntolerance.status | AllergyIntoleranceStatus | required | AllergyIntoleranceStatus |
AllergyIntolerance.criticality | AllergyIntoleranceCriticality | required | AllergyIntoleranceCriticality |
AllergyIntolerance.type | AllergyIntoleranceType | required | AllergyIntoleranceType |
AllergyIntolerance.category | AllergyIntoleranceCategory | required | AllergyIntoleranceCategory |
AllergyIntolerance.reaction.substance | Substance Code | example | Substance Code |
AllergyIntolerance.reaction.certainty | AllergyIntoleranceCertainty | required | AllergyIntoleranceCertainty |
AllergyIntolerance.reaction.manifestation | HSPC SNOMED Clinical Findings Value Set Definition | preferred | HSPC SNOMED Clinical Findings Value Set Definition |
AllergyIntolerance.reaction.severity | AllergyIntoleranceSeverity | required | AllergyIntoleranceSeverity |
AllergyIntolerance.reaction.exposureRoute | v3 Code System RouteOfAdministration | preferred | v3 Code System RouteOfAdministration |
Id | Path | Details | Requirements |